/*
 * Copyright (c) 2023-2025 elsfs Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.elsfs.cloud.starter.excel.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.elsfs.cloud.starter.excel.handler.DefaultAnalysisEventListener;
import org.elsfs.cloud.starter.excel.handler.ListAnalysisEventListener;

/** 导入excel */
@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestExcel {

  /** 前端上传字段名称 file */
  String fileName() default "file";

  /**
   * 读取的监听器类
   *
   * @return readListener
   */
  Class<? extends ListAnalysisEventListener<?>> readListener() default
      DefaultAnalysisEventListener.class;

  /**
   * 是否跳过空行
   *
   * @return 默认跳过
   */
  boolean ignoreEmptyRow() default false;

  /**
   * 读取的标题行数
   *
   * @return 默认读取1行
   */
  int headRowNumber() default 1;
}
